// Copyright (C) 2021 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package api

import (
	"context"
	"errors"

	"github.com/google/gapid/gapis/service/path"
)

var (
	// ErrPipelineNotAvailable is an error returned by PipelineProvider if the
	// pipelines are requested on an object that does not have pipelines.
	ErrPipelineNotAvailable = errors.New("Pipelines not available at this command")
)

// BoundPipeline represents a pipeline resource and its data currently bound.
type BoundPipeline struct {
	Pipeline Resource
	Data     *ResourceData
}

// PipelineProvider is the interface implemented by types that provide pipelines.
type PipelineProvider interface {
	// BoundPipeline returns the pipeline bound at object o.
	BoundPipeline(ctx context.Context, o interface{}, p *path.Pipelines, r *path.ResolveConfig) (BoundPipeline, error)
}
